IMotion.GetAxisParameter method

Gets the value of a vendor-specific parameter from an axis. The returned value has to be converted to double if necessary. If not possible, the vendor has to supply a vendor-specific method to read the parameter. The parameters are defined in McAxisParameter.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsReturn<double> GetAxisParameter(
       int Index,
       McAxisParameter ParameterNumber
)

Function GetAxisParameter(
       Index As Integer,
       ParameterNumber As McAxisParameter
) As KsReturn(Of Double)

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

ParameterNumber [in]

Type: McAxisParameter

A parameter from McAxisParameter. You can use the parameter name or its corresponding number.

Return value

Type: KsReturn<double>

Returns a KsError code and a double value.

Examples

N/A